﻿// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
// Copyright (c) 2011, Dr. Masroor Ehsan
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of the author nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// $Author:$
// $Id:$
// $Rev:$
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

using System;
using MaxTrader.Core;

namespace MaxTrader.BusinessObjects
{
    public abstract class AbstractAccount : Entity, IComparable<AbstractAccount>, ICloneable,
                                            IEquatable<AbstractAccount>
    {
        public virtual AccountType AccountType { get; protected set; }

        public virtual Currency Currency { get; protected set; }

        public virtual string AccountName { get; set; }

        public virtual Portfolio Portfolio { get; set; }

        #region ICloneable Members

        public abstract object Clone();

        #endregion

        #region IComparable<AbstractAccount> Members

        public virtual int CompareTo(AbstractAccount other)
        {
            return AccountName.CompareTo(other.AccountName);
        }

        #endregion

        #region IEquatable<AbstractAccount> Members

        public abstract bool Equals(AbstractAccount other);

        #endregion

        /// <summary>
        ///   Return the value of this account on the given day.
        /// </summary>
        public abstract Money GetValue();

        /// <summary>
        ///   Return the value of this account on the given day.
        /// </summary>
        public abstract Money GetValue(IQuoteSource quoteBundle, TradingDate date);

        /// <summary>
        ///   Perform a transaction on this account.
        /// </summary>
        public abstract void ApplyTransaction(AbstractTransaction transaction);
    }
}